Update Users section of the docs #494

andrii-i · 2023-11-30T01:32:28Z

Problem

Currently "Model providers" section of the user docs (https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers) shows an example of setting an API key as env variable. But that will only work for the magics providers. To set API keys for chat interface, users need to use chat settings UI or config.json.

Note that users are getting introduced to %ai magic commands in "The %ai and %%ai magic commands" section of the docs (https://jupyter-ai.readthedocs.io/en/latest/users/index.html#the-ai-and-ai-magic-commands) which is located much further down the page.

The chat interface section of the user docs has screenshots of previous version of chat settings UI https://jupyter-ai.readthedocs.io/en/latest/users/index.html#the-chat-interface

Currently user docs have “Custom model providers” and “Customizing prompt templates” sub-subsections that explain how to customize J-AI with code before “The chat interface” subsection that explains how to use J-AI's interface.

All three might be confusing for new users not familiar with Jupyter-AI and make onboarding experience hard(er).

Proposed Solution

Update "Model providers" section of the docs replacing use of env variable in the example with a use of chat settings UI or config.json.
Update chat settings screenshots
Promote “Custom model providers” and “Customizing prompt templates” sub-subsections to sub-sections, move them to the bottom of the users doc page, below “The chat interface” and “Configuration” sub-sections section. Now table of content would look like:

…o subsections, move them to the bottom of the users doc page

docs/source/users/index.md

Co-authored-by: Michał Krassowski <[email protected]>

docs/source/_static/chat-settings-choose-language-model.png

docs/source/users/index.md

Co-authored-by: Michał Krassowski <[email protected]>

…ction

andrii-i · 2023-12-01T07:50:08Z

@JasonWeill @3coins @krassowski thank you very much for looking into this PR. All comments were addressed, please give it a look again when possible.

docs/source/users/index.md

docs/source/developers/index.md

docs/source/users/index.md

Co-authored-by: Jason Weill <[email protected]>

JasonWeill · 2023-12-04T18:24:08Z

docs/source/users/index.md

-variable when you start JupyterLab from a terminal:
+For example, to use OpenAI models, use the chat interface settings panel to choose the OpenAI language model:
+
+<img src="../_static/chat-settings-choose-language-model.png"


The screen shot doesn't show any OpenAI language models. While we as users know that we can scroll down to pick an OpenAI model, in the docs, it might be better to show a screen shot with an OpenAI model visible.

Alternatively, you can change the text above to say, "For example, to use AI21 models, …"

…xt around the screenshot

3coins

LGTM! Thanks for making all the updates.

andrii-i · 2023-12-04T19:03:13Z

Thank you for looking into this everyone.

* Update example of setting model provider and API key * resize screenshots * update chat settings screenshots * Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * change double-backtick to single-backticks as they serve the same function * move Prompt templates sections to Developers page * Update snapshots to use the same zoom level * Update docs/source/developers/index.md Co-authored-by: Jason Weill <[email protected]> * move "Custom model providers" section to Dev page * Update lang model choice screen to show OpenAI models mentioned in text around the screenshot --------- Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Jason Weill <[email protected]>

@3coins

* Update Users section of the docs (#494) * Update example of setting model provider and API key * resize screenshots * update chat settings screenshots * Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * change double-backtick to single-backticks as they serve the same function * move Prompt templates sections to Developers page * Update snapshots to use the same zoom level * Update docs/source/developers/index.md Co-authored-by: Jason Weill <[email protected]> * move "Custom model providers" section to Dev page * Update lang model choice screen to show OpenAI models mentioned in text around the screenshot --------- Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Jason Weill <[email protected]> * remove config.json-related information (#503) * Base chat handler refactor for custom slash commands (#398) * Adds attributes, starts adding to subclasses * Consistent syntax * Help for all handlers * Fix slash ID error * Iterate through entry points * Fix typo in call to select() * Moves config to magics, modifies extensions to attempt to load classes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Moves config to proper location, improves error logging * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * WIP: Updates per feedback, adds custom handler * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Removes redundant code, style fixes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Removes unnecessary custom message * Instantiates class * Validates slash ID * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Consistent arguments to chat handlers * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Refactors to avoid intentionally unused params * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Updates docs, removes custom handler from source and config * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Renames process_message to match base class * Adds needed parameter that had been deleted * Joins lines in contributor doc * Removes natural language routing type, which is not yet used * Update docs/source/developers/index.md Co-authored-by: Piyush Jain <[email protected]> * Update docs/source/developers/index.md Co-authored-by: Piyush Jain <[email protected]> * Update docs/source/developers/index.md Co-authored-by: Piyush Jain <[email protected]> * Revises per @3coins, avoids Latinism * Removes Configurable, since we do not yet have configurable traits * Uses Literal for validation * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Piyush Jain <[email protected]> --------- Co-authored-by: Andrii Ieroshenko <[email protected]> Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Jason Weill <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Piyush Jain <[email protected]>

* Update example of setting model provider and API key * resize screenshots * update chat settings screenshots * Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * change double-backtick to single-backticks as they serve the same function * move Prompt templates sections to Developers page * Update snapshots to use the same zoom level * Update docs/source/developers/index.md Co-authored-by: Jason Weill <[email protected]> * move "Custom model providers" section to Dev page * Update lang model choice screen to show OpenAI models mentioned in text around the screenshot --------- Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Jason Weill <[email protected]>

Update example of setting model provider and API key

2b57c21

andrii-i added the documentation Improvements or additions to documentation label Nov 30, 2023

resize screenshots

9189a97

andrii-i changed the title ~~Update example of setting model provider and API key in the user documentation~~ Update example of setting API keys, chat settings screenshots in the user documentation Nov 30, 2023

andrii-i changed the title ~~Update example of setting API keys, chat settings screenshots in the user documentation~~ Update example of setting API keys, update chat settings screenshots in the user documentation Nov 30, 2023

andrii-i added 2 commits November 29, 2023 23:52

update chat settings screenshots

7d7f6f6

Promote “Custom model providers” and “Customizing prompt templates” t…

a2eec76

…o subsections, move them to the bottom of the users doc page

andrii-i changed the title ~~Update example of setting API keys, update chat settings screenshots in the user documentation~~ Update Users section of the docs Nov 30, 2023

krassowski reviewed Nov 30, 2023

View reviewed changes

docs/source/users/index.md Outdated Show resolved Hide resolved

Update docs/source/users/index.md

2be81c4

Co-authored-by: Michał Krassowski <[email protected]>

3coins reviewed Nov 30, 2023

View reviewed changes

docs/source/_static/chat-settings-choose-language-model.png Outdated Show resolved Hide resolved

3coins reviewed Nov 30, 2023

View reviewed changes

docs/source/users/index.md Outdated Show resolved Hide resolved

JasonWeill reviewed Nov 30, 2023

View reviewed changes

docs/source/users/index.md Outdated Show resolved Hide resolved

krassowski reviewed Nov 30, 2023

View reviewed changes

docs/source/users/index.md Outdated Show resolved Hide resolved

andrii-i and others added 2 commits November 30, 2023 14:16

Update docs/source/users/index.md

72a51e5

Co-authored-by: Michał Krassowski <[email protected]>

change double-backtick to single-backticks as they serve the same fun…

2360f60

…ction

andrii-i mentioned this pull request Dec 1, 2023

Allow prompt template customization for Jupyter AI chat. #498

Closed

andrii-i added 2 commits November 30, 2023 23:04

move Prompt templates sections to Developers page

f1bda42

Update snapshots to use the same zoom level

ea61df1

krassowski reviewed Dec 1, 2023

View reviewed changes

docs/source/users/index.md Outdated Show resolved Hide resolved

JasonWeill reviewed Dec 1, 2023

View reviewed changes

docs/source/developers/index.md Outdated Show resolved Hide resolved

docs/source/users/index.md Outdated Show resolved Hide resolved

andrii-i and others added 2 commits December 4, 2023 09:16

Update docs/source/developers/index.md

958c21c

Co-authored-by: Jason Weill <[email protected]>

move "Custom model providers" section to Dev page

739b535

JasonWeill reviewed Dec 4, 2023

View reviewed changes

Update lang model choice screen to show OpenAI models mentioned in te…

a08f522

…xt around the screenshot

3coins approved these changes Dec 4, 2023

View reviewed changes

andrii-i merged commit 9c69a7b into jupyterlab:main Dec 4, 2023
5 of 6 checks passed

andrii-i deleted the docs_setting_env_variable branch December 4, 2023 19:26

andrii-i mentioned this pull request Dec 5, 2023

Remove config.json-related information #503

Merged

dlqqq mentioned this pull request Dec 8, 2023

Backport PRs: #494, #503, #398 #512

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Users section of the docs #494

Update Users section of the docs #494

andrii-i commented Nov 30, 2023 •

edited

Loading

andrii-i commented Dec 1, 2023 •

edited

Loading

JasonWeill Dec 4, 2023

3coins left a comment

andrii-i commented Dec 4, 2023

Update Users section of the docs #494

Update Users section of the docs #494

Conversation

andrii-i commented Nov 30, 2023 • edited Loading

Problem

Proposed Solution

andrii-i commented Dec 1, 2023 • edited Loading

JasonWeill Dec 4, 2023

Choose a reason for hiding this comment

3coins left a comment

Choose a reason for hiding this comment

andrii-i commented Dec 4, 2023

andrii-i commented Nov 30, 2023 •

edited

Loading

andrii-i commented Dec 1, 2023 •

edited

Loading